package com.sub.structure;

/**
 * @ClassName SubLinkedList
 * @Description: 链表：线性的数据结构，由一组节点组成，每个节点包含两部分：数据域和指针域。
 * 逻辑结构：链表（Linked List）是一个线性结构，由一系列节点（Node）组成，每个节点包含一个数据元素和一个指向下一节点的指针（Pointer）。
 * 所有节点通过指针相连，形成一个链式结构。通常我们将链表中的第一个节点称为头结点，并将头结点的位置作为整个链表的位置标识。
 * 物理结构：与数组不同，链表中每个节点分散的存储在内存中，每个节点都保存了当前节点的数据和下一节点的地址（指针）。
 * 功能定义：
 * 方法	功能说明
 * int size()	返回链表元素个数
 * boolean isEmpty()	判断链表是否为空
 * add(E element)	在末尾插入元素
 * add(int index, E element)	在指定位置插入新元素
 * E get(int index)	获取指定位置的元素
 * E remove(int index)	删除指定位置的元素，并返回删除内容
 * E set(int index, E element)	修改指定位置的内容
 * forEach(Consumer<E> consumer)	遍历链表元素
 * @Author Submerge.
 * @Since 2025/5/16 16:26
 * @Version 1.0
 */
public class SubLinkedList<E> {

    //链表节点定义：每个节点由数据域和指针域组成，指针域指向下一个节点，形成一个链式结构
    private static class Node<E> {
        // 数据域：保存当前数据
        E element;
        // 指针域：指向下一个节点
        Node<E> next;

        public Node(E element, Node<E> next) {
            this.element = element;
            this.next = next;
        }
    }

    //链表的头节点
    private Node<E> head;

    //链表的尾节点
    private Node<E> tail;

    //链表的长度
    private int size;

    /**
     * 获取当前元素个数
     *
     * @return 个数
     */
    public int size() {
        return size;
    }

    /**
     * 判断链表是否为空
     *
     * @return 是否为空
     */
    public boolean isEmpty() {
        return size == 0;
    }

    /**
     * 在链表末尾添加元素
     *
     * @param element 要添加的新元素
     */
    public void add(E element) {
        add(size, element);
    }

    /**
     * 在指定位置插入元素
     * 1、判断插入位置是否合法
     * 2、判断是否为头结点插入
     * 3、判断是否为尾节点插入
     *
     * @param index   要插入的位置
     * @param element 要插入的新元素
     */
    public void add(int index, E element) {
        if (index < 0 || index > size) {
            throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + size);
        }
        if (index == 0) {
            // 头结点插入，头节点数据为当前元素，指针指向旧的头节点
            head = new Node<>(element, head);
            if (size == 0) {
                //第一次插入，头节点和尾节点都指向新节点
                tail = head;
            }
        } else {
            //非头节点（中间和尾部节点）插入，找到插入位置的前一个节点，将前一个节点的指针指向新节点，新节点的指针指向下一节点
            Node<E> preNode = getNode(index - 1);
            Node<E> oldCurrentNode = preNode.next;
            preNode.next = new Node<>(element, oldCurrentNode);
            if (index == size) {
                // 尾节点插入，尾节点数据为当前元素，指针指向新节点
                tail = preNode.next;
            }
        }
        size++;
    }

    /**
     * 获取指定位置的元素
     * 1、判断插入位置是否合法
     * 2、从头节点开始遍历，遍历到要获取的指定位置，赋值给当前节点
     * 3、返回当前节点
     *
     * @param index 要获取的位置
     * @return 元素
     */
    private Node<E> getNode(int index) {
        if (index < 0 || index >= size) {
            throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + size);
        }
        Node<E> current = head;
        for (int i = 0; i < index; i++) {
            current = current.next;
        }
        return current;
    }

    /**
     * 获取指定节点的元素
     *
     * @param index
     * @return
     */
    public E get(int index) {
        return getNode(index).element;
    }

    /**
     * 删除指定位置的元素，并返回删除内容
     * 1、判断插入位置是否合法
     * 2、判断是否为头结点删除，
     * 3、判断是否为尾节点删除
     *
     * @param index 要删除的位置
     * @return 删除内容
     */
    public E remove(int index) {
        if (index < 0 || index >= size) {
            throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + size);
        }
        Node<E> current = getNode(index);
        if (index == 0 && index == size - 1) {
            head = null;
            tail = null;
        } else if (index == 0) {
            //删除头节点：改变链表的的头标识位
            head = current.next;
        } else if (index == size - 1) {
            //删除尾节点：将上一节点作为新的尾部节点并指向为空
            tail = getNode(index - 1);
            tail.next = null;
        } else {
            //删除中间节点：将它的上一节点的指针指向它的下一节点
            Node<E> pre = getNode(index - 1);
            pre.next = current.next;
        }
        size--;
        return current.element;
    }

    /**
     * 修改指定位置的元素
     *
     * @param index   要修改的位置
     * @param element 要修改的新元素
     * @return 修改前的元素
     */
    public E set(int index, E element) {
        if (index < 0 || index >= size) {
            throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + size);
        }
        Node<E> current = head;
        for (int i = 0; i < index; i++) {
            current = current.next;
        }
        E old = current.element;
        current.element = element;
        return old;
    }

    /**
     * 遍历链表元素
     */
    public void forEach(java.util.function.Consumer<E> consumer) {
        Node<E> current = head;
        while (current != null) {
            consumer.accept(current.element);
            current = current.next;
        }
    }

    /**
     * 重写toString方法
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("SubLinkedList{");
        Node<E> current = head;
        while (current != null) {
            sb.append(current.element);
            current = current.next;
            if (current != null) {
                sb.append(", ");
            }
        }
        sb.append("}");
        return sb.toString();
    }


}
